Update product

Updates a single product within a composed menu. Use this endpoint when your POS or RMS pushes item-level changes — pricing, availability, or bundled items — without replacing the entire menu payload. The request body uses the same menu product shape as products in Upsert menus. Send only the fields you want to change; omitted fields keep their current values.

Requires an access token with the menus:write scope. See Token to obtain a token.

Path parameters

Parameter	Description
`id`	External product identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters.

Query parameters

Parameter	Required	Description
`brand_id`	No	External brand identifier. Omit or pass `__ANY__` for the merchant-wide default. When set, scope the update to menus for this brand only.
`store_id`	No	External store identifier. Scope the update to menus for this store. Omit or pass `__ANY__` for the merchant-wide default.
`channel_id`	No	External channel identifier. Scope the update to menus for this channel. Omit or pass `__ANY__` for the menu synced without a channel (`__ANY__`).
`fulfillment_id`	No	External fulfillment identifier. Scope the update to menus for that fulfillment type. Omit or pass `__ANY__` for the menu synced without a fulfillment (`__ANY__`). See List fulfillment.
`menu_id`	No	External menu identifier. Picks which menu to look up the product in when several menus share the same scope — for example lunch and dinner schedules. The change is stored for the scope, so it applies to every menu in that scope that contains the product.

Omitting a scope parameter does not mean “all”: it resolves to __ANY__ and only matches menus synced with __ANY__ for that dimension. If menus were synced per fulfillment or channel (for example TAKEAWAY and DINE_IN), send one update per scope; when no menu exists for the requested scope the response is 404. Each composed menu is keyed by fulfillment_id + store_id + channel_id + brand_id + menu.id; see Menu sync.

Request body

Same shape as a product in the products array on Upsert menus. The product id is set in the path parameter — omit it from the request body. Every field is optional on update, including the fields inside pricing and availability. Omitted fields keep their current values and no defaults are applied:

pricing and availability merge field by field. { "pricing": { "price": 2.49 } } changes only the price; modifiers, modifier_group_ids, and quantity limits stay as they are.
Arrays (bundled_items, labels, pricing.modifiers, …) are replaced as a whole when sent.
To clear out_of_stock_until when switching back to AVAILABLE, send "out_of_stock_until": null.

products

Each product in the request body:

Field	Required	Type	Description
`id`	Yes	string	External product identifier. Set via the path parameter — omit from the request body.
`name`	Yes	object	Localized display name keyed by locale (for example `en_us`).
`description`	No	object \| null	Localized description. `null` when omitted.
`image_url`	No	string	Product image URL. `null` when omitted.
`bundled_items`	No	array	Items included in a bundle or combo. Defaults to `[]`.
`pricing`	Yes	object	Price, tax, quantity limits, and modifier configuration. See pricing.
`availability`	Yes	object	Product availability. See fields below.
`labels`	No	string[]	Short labels for Dashboard filters and quick selection. At most 64 strings (1–128 characters each). Defaults to `[]`.
`tags`	No	object	Key/value tags for advanced custom rules. Values may be boolean, string, or number. Defaults to `{}`. See Custom rules.
`metadata`	No	object	Partner-specific metadata. Defaults to `{}`.

Each availability object:

Field	Required	Type	Description
`status`	Yes	string	`AVAILABLE`, `HIDDEN`, or `OUT_OF_STOCK`.
`schedules`	No	array \| null	Schedule entries with `day_of_week` and `periods`. `null` when there is no schedule restriction.
`out_of_stock_until`	No	string	Optional ISO 8601 datetime when the product returns to stock.

Each bundled_items entry:

Field	Required	Type	Description
`id`	Yes	string	External identifier of the bundled product.
`refund_price`	Yes	number	Refund amount when the customer removes this item from the bundle. ≥ 0.
`included_quantity`	Yes	number	Units included by default. ≥ 0.

Example product

{
  "id": "burger-classic",
  "name": { "en_us": "Classic burger" },
  "description": { "en_us": "Angus beef patty with lettuce and tomato." },
  "image_url": "https://cdn.example.com/burger-classic.jpg",
  "bundled_items": [],
  "pricing": {
    "minimum_quantity": 1,
    "maximum_quantity": 10,
    "is_tax_inclusive": true,
    "tax_rate": 0.15,
    "price": 12.99,
    "anchor_price": 14.99,
    "anchor_price_percentage": 0.13,
    "modifiers": [],
    "modifier_group_ids": ["choose-drink"]
  },
  "availability": {
    "status": "AVAILABLE",
    "schedules": null,
    "out_of_stock_until": null
  },
  "metadata": {}
}

pricing

Product pricing in the request body:

Field	Required	Type	Description
`minimum_quantity`	No	number	Minimum units per order. ≥ 0. Defaults to `0`.
`maximum_quantity`	No	number	Maximum units per order. 0–1,000,000. Defaults to `1000000`.
`is_tax_inclusive`	Yes	boolean	Whether `price` includes tax.
`tax_rate`	Yes	number	Tax rate as a decimal (for example `0.15` for 15%). 0–1.
`price`	Yes	number	List price. ≥ 0.
`anchor_price`	No	number	Reference price for strikethrough or comparison. ≥ 0.
`anchor_price_percentage`	No	number	Discount shown relative to `anchor_price`. 0–1.
`starting_price`	No	number \| null	Reference “From” price. Send a number to set it or `null` to hide it. This endpoint stores the value as sent; it does not recalculate it. ≥ 0.
`modifiers`	No	array	Per-group pricing and selection overrides. Defaults to `[]`.
`modifier_group_ids`	No	array	External modifier group identifiers attached to this product. Defaults to `[]`.
`variant_group_ids`	No	array	Read-only here. Variant links are managed by menu sync; this endpoint keeps the stored value. Sending `modifier_group_ids` for a product with variant groups returns `422`.
`variants`	No	array	Read-only here. Managed by menu sync; this endpoint keeps the stored value.

Each object in modifiers configures one modifier group referenced in modifier_group_ids. It accepts the same pricing fields as the parent product, plus modifier-specific fields:

Field	Required	Type	Description
`modifier_group_id`	Yes	string	External modifier group identifier. Must match a group in `modifier_group_ids`.
`minimum_quantity`	No	number	Minimum units per order for modifiers in this group. ≥ 0. Defaults to `0`.
`maximum_quantity`	No	number	Maximum units per order for modifiers in this group. 0–1,000,000.
`is_tax_inclusive`	Yes	boolean	Whether `price` includes tax for modifiers in this group.
`tax_rate`	Yes	number	Tax rate as a decimal (for example `0.15` for 15%). 0–1.
`price`	Yes	number	List price for modifiers in this group. ≥ 0.
`anchor_price`	No	number	Reference price for strikethrough or comparison. ≥ 0.
`anchor_price_percentage`	No	number	Discount shown relative to `anchor_price`. 0–1.
`default_quantity`	Yes	number	Pre-selected quantity for modifiers in this group. ≥ 0.
`charge_above_quantity`	No	number	Free selections before charges apply. Optional.
`display_type`	No	string	How modifiers render in the UI: `RADIO`, `CHECKBOX`, or `QUANTITY`. Optional.

Example modifiers entry

{
  "modifier_group_id": "choose-drink",
  "minimum_quantity": 0,
  "maximum_quantity": 1,
  "is_tax_inclusive": true,
  "tax_rate": 0.15,
  "price": 0,
  "anchor_price": 0,
  "anchor_price_percentage": 0,
  "default_quantity": 1,
  "charge_above_quantity": 0,
  "display_type": "RADIO"
}

Response

Returns the updated product in data — the same shape as a product in List menus, including id, name, pricing, availability, bundled_items, and metadata.

Error responses

Status	Description
`400`	Validation error. Body is `{ "error": "Invalid fields", "details": { "<path>": "<message>" } }`.
`401`	Missing or invalid access token.
`403`	Token does not include the `menus:write` scope.
`404`	No product with this `id` exists in the menu.

API Documentation

Endpoints

Guides

Resources

Path parameters

Query parameters

Request body

Response

Error responses

​Path parameters

​Query parameters

​Request body

​Response

​Error responses

Path parameters

Query parameters

Request body

Response

Error responses